gridpack::analysis::StatBlock Class Reference

#include <stat_block.hpp>

List of all members.

Classes
struct	index_set
Public Member Functions
	StatBlock (const parallel::Communicator &comm, int nrows, int ncols)
	~StatBlock (void)
void	addColumnValues (int idx, std::vector< double > vals, std::vector< int > mask)
void	addRowLabels (std::vector< int > indices, std::vector< std::string > tags)
void	addRowLabels (std::vector< int > idx1, std::vector< int > idx2, std::vector< std::string > tags)
void	addRowMinValue (std::vector< double > min)
void	addRowMaxValue (std::vector< double > max)
void	writeMeanAndRMS (std::string filename, int mval=1, bool flag=true)
void	writeMinAndMax (std::string filename, int mval=1, bool flag=true)
void	writeMaskValueCount (std::string filename, int mval, bool flag=true)
void	sumColumnValues (std::string filename, int mval=1)

---

Constructor & Destructor Documentation

gridpack::analysis::StatBlock::StatBlock	(	const parallel::Communicator &	comm,
		int	nrows,
		int	ncols
	)

Constructor

Parameters:

	comm	communicator on which StatBlock is defined
	nrows	number of rows in data array
	ncols	number of columns in data array

gridpack::analysis::StatBlock::~StatBlock

(

void

)

Default destructor

---

Member Function Documentation

void gridpack::analysis::StatBlock::addColumnValues	(	int	idx,
		std::vector< double >	vals,
		std::vector< int >	mask
	)

Add a column of data to the stat block

Parameters:

	idx	index of column
	vals	vector of column values
	mask	vector of mask values

void gridpack::analysis::StatBlock::addRowLabels	(	std::vector< int >	idx1,
		std::vector< int >	idx2,
		std::vector< std::string >	tags
	)

Add two branch indices and device tag that can be used to label rows

Parameters:

	idx1	vector of index 1
	idx2	vector of index 2
	tags	vector of character tags

void gridpack::analysis::StatBlock::addRowLabels	(	std::vector< int >	indices,
		std::vector< std::string >	tags
	)

Add index and device tag that can be used to label rows

Parameters:

	indices	vector of indices
	tags	vector of character tags

void gridpack::analysis::StatBlock::addRowMaxValue

(

std::vector< double >

max

)

Add the maximum allowed value per row

Parameters:

max

vector containing maximum value for each row

void gridpack::analysis::StatBlock::addRowMinValue

(

std::vector< double >

min

)

Add the minimum allowed value per row

Parameters:

max

vector containing minimum value for each row

void gridpack::analysis::StatBlock::sumColumnValues	(	std::string	filename,
		int	mval = 1
	)

Sum up the values in the columns and print the result as a function of column index

Parameters:

	filename	name of file containing results
	mval	only include values with this mask value or greater

void gridpack::analysis::StatBlock::writeMaskValueCount	(	std::string	filename,
		int	mval,
		bool	flag = true
	)

Write out file containing number of mask entries at each row that correspond to a given value

Parameters:

	filename	name of file containing results
	mval	count number of times this mask value occurs
	flag	if false, do not include tag ids in output

void gridpack::analysis::StatBlock::writeMeanAndRMS	(	std::string	filename,
		int	mval = 1,
		bool	flag = true
	)

Write out file containing mean value and RMS deviation for values in table

Parameters:

	filename	name of file containing results
	mval	only include values with this mask value
	flag	if false, do not include tag ids in output

void gridpack::analysis::StatBlock::writeMinAndMax	(	std::string	filename,
		int	mval = 1,
		bool	flag = true
	)

Write out file containing Min an Max values in table for each row

Parameters:

	filename	name of file containing results
	mval	only include values with this mask value or greater
	flag	if false, do not include tag ids in output

---

The documentation for this class was generated from the following file:

• stat_block.hpp